Skip to content

docs: hide mode and theme props, unhide children props #3181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

docs: hide mode and theme props, unhide children props #3181

wants to merge 7 commits into from

Conversation

aresnik11
Copy link
Contributor

@aresnik11 aresnik11 commented Oct 8, 2025 •
edited
Loading

Overview

Automatically hides mode and theme props from the props table. Unhides children prop from props table when it doesn't have an associated jsdoc. Hides the as prop on button stories where the type is actually as?: never

PR Checklist

  • Related to designs:
  • Related to JIRA ticket: GMT-138, GMT-1440
  • I have run this code to verify it works
  • This PR includes unit tests for the code change N/A
  • This PR includes testing instructions tests for the code change
  • The alpha package of this PR is passing end-to-end tests in all relevant Codecademy repositories N/A

Testing Instructions

  1. Go to one of the button stories
  2. Confirm you don't see as, mode or theme props in props table
  3. Go to ExpandInCollapseOut story
  4. See children prop in props table is now typed to ReactNode | ReactNode[]
  5. Go to PopoverContainer story
  6. See children prop in props table is now typed to ReactNode | ReactNode[]
  7. Go to Overlay story
  8. See children prop in props table
  9. Spot check some stories and see that everything still looks great
  10. Finish and do a celebratory dance

PR Links and Envs

N/A

Repository PR Link
Monolith Monolith PR
Mono Mono PR

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Oct 8, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit ec66df4

Command Status Duration Result
nx run-many --target=verify --parallel=3 --all ✅ Succeeded <1s View ↗
nx run-many --target=build --all ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2025-10-20 18:58:12 UTC

@codecademydev
Copy link
Collaborator

📬Published Alpha Packages:

@codecademy/[email protected]

@codecademydev
Copy link
Collaborator

🚀 Styleguide deploy preview ready!

https://68e6c5b374aa32bf1f3970f5--gamut-preview.netlify.app

Deploy Logs

@aresnik11 aresnik11 changed the title Ajr sb react docgen updates docs: hide mode and theme props, unhide children props Oct 17, 2025
@aresnik11 aresnik11 marked this pull request as ready for review October 17, 2025 19:50
@aresnik11 aresnik11 requested a review from a team as a code owner October 17, 2025 19:50
LinKCoding
LinKCoding approved these changes Oct 20, 2025
View reviewed changes
Copy link
Contributor

@LinKCoding LinKCoding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

QA'd the buttons, PopoverContainer, ExpandInCollapseOut, and Overlay — they all look good :)

Also spot-checked RadialProgress and Box (and clicked around) 🔥

@codecademydev
Copy link
Collaborator

📬 Published Alpha Packages:

@codecademy/[email protected]

@github-actions GitHub Actions
Copy link
Contributor

🚀 Styleguide deploy preview ready!

Preview URL: https://68f68706b0c537dd5326be1e--gamut-preview.netlify.app
Deploy Logs: https://app.netlify.com/projects/gamut-preview/deploys/68f68706b0c537dd5326be1e

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LinKCoding LinKCoding LinKCoding approved these changes

@dreamwasp dreamwasp dreamwasp approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@aresnik11 @codecademydev @LinKCoding @dreamwasp